home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / oman_174.zip / OMAN.REF < prev    next >
Text File  |  1992-01-27  |  14KB  |  313 lines
  1.  ╔════════════════════════════════════════════════════════════════════════╗
  2.  ║              Opus CBCS Computer Based Conversation System              ║
  3.  ║                                                                        ║
  4.  ╟────────────────────────────────────────────────────────────────────────╢
  5.  ║              oMAN Configuration Reference for Version 1.74             ║
  6.  ╟────────────────────────────────────────────────────────────────────────╢
  7.  ║            oMAN, oPIE and BONK are copyrighted (C) 1988-1992           ║
  8.  ║                     by Tom Kashuba and Ulf Nilsson                     ║
  9.  ╟────────────────────────────────────────────────────────────────────────╢
  10.  ║                         * All Rights Reserved *                        ║
  11.  ╚════════════════════════════════════════════════════════════════════════╝
  12. ;
  13. ;  This text briefly summarizes the commands for oMAN's optional
  14. ;  configuration file, OMAN.CFG.  It is presented in lieu of a more
  15. ;  complete, future documentation file.
  16. ;
  17. ;  The OMAN.CFG file is only ecessary when you want to modify the way
  18. ;  Bonk operates or to preset some items to allow quick invocation with
  19. ;  minimal or no command line options.
  20. ;
  21. ;  Assuming your OPUS parameter file were named MY.PRM and all of the
  22. ;  OMAN files (EXE and HLP) were in your Opus home directory, the bare
  23. ;  bones way to run Oman would be to enter ...
  24. ;
  25. ;     CD \OPUS   
  26. ;     OMAN BBS
  27. ;
  28. ;  In that case, no CFG file is needed.  However, since your PRM file
  29. ;  seldom changes name and you will probably want to use the VIDEO RAM
  30. ;  option, then you might create the following CFG file ...
  31. ;
  32. ;     VIDEO RAM
  33. ;     PARAM MY
  34. ;
  35. ;  Then, all you would need to do to run Oman would be to enter ...
  36. ;
  37. ;
  38. ;     OMAN
  39. ;
  40. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  41. ;
  42. ;  The rest of this text describes all of the other options that are
  43. ;  possible to further tailor OMAN to your needs.  The following
  44. ;  characters are used throughout this text to described the various
  45. ;  options:
  46. ;
  47. ;     {} encloses required items
  48. ;     [] encloses optional items
  49. ;      | Separates choices
  50. ;
  51. ;
  52. ;-----------------------------------------------------------------------
  53. ;  OMAN MODE ITEMS
  54. ;-----------------------------------------------------------------------
  55. ;
  56. ;  CMDline   {ON | Off}
  57. ;
  58. ;     Tells Oman to ignore command line parameters.  Useful only when
  59. ;     parameters passed are not compatible with Oman.  Default = ON.
  60. ;
  61. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  62. ;  VIDEO   { DOS | IBM | RAM [0xAAAA] | FOSSIL }
  63. ;
  64. ;     Sets the Video Mode that Pman uses to write to the screen.
  65. ;     DOS is the default and horrendously slow.  Use RAM if possible.
  66. ;
  67. ;        DOS ... Plain DOS calls / Very Slow / For any DOS machine
  68. ;        IBM ... IBM BIOS calls  / Slow      / For most IBM-PC clones
  69. ;        FOSSIL  FOSSIL calls    / Medium    / Wherever FOSSIL loaded
  70. ;
  71. ;        RAM ... Direct Screen   / Fast      / For exact IBM-PC clones
  72. ;
  73. ;        Use the optional '0xAAAA' RAM suboption *only* when your video
  74. ;        buffer address is non-standard.  Oman normally auto-senses and
  75. ;        uses the standard ones of 0xB000 and 0xB800 for MDA and xGA modes.
  76. ;
  77. ;     Default = DOS.
  78. ;
  79. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  80. ;  PARAM   { None | path\prm }
  81. ;
  82. ;     Tells Oman to either *not* expect any Opus.Prm file or to use the
  83. ;     one specified.  This option is seldom needed.
  84. ;
  85. ;     Use "NONE" when you explicitly do *not* want to use a particular
  86. ;     PRM file, setting all values in the Oman CFG file only.
  87. ;
  88. ;     Specify "path\prm" when you want to use a secific PRM file. This
  89. ;     allows you to run Oman without a PRM file on the command line.
  90. ;
  91. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  92. ;  ULIST   { path\name.ext }
  93. ;
  94. ;     Specifies an alternate default path or device to use for the
  95. ;     user manager's report output.  Only needed if you do not like
  96. ;     the existing default.  In any case, you can override the default
  97. ;     when you request the report.
  98. ;
  99. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  100. ;  ALIST   { path\name.ext }
  101. ;
  102. ;     Specifies an alternate default path or device to use for the
  103. ;     area manager's report output.  Only needed if you do not like
  104. ;     the existing default.  In any case, you can override the default
  105. ;     when you request the report.
  106. ;
  107. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  108. ;  COLOR   { ON | OFF }
  109. ;
  110. ;     Forces color mode ON or OFF.  Normally Oman uses the BIOS color
  111. ;     mode to select between color or monochrome rendering of text.
  112. ;     Use only if Oman selects the wrong setting for your setup.
  113. ;
  114. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  115. ;  OPUSRoot   { path }
  116. ;
  117. ;     Sets the path to your Opus Home directory in those cases where you
  118. ;     are running OMAN in a directory other than the Opus Home directory.
  119. ;
  120. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  121. ;  OHMfmt   { FILEs | NOCALLs | ZARCs | ZMODs | ALL }
  122. ;
  123. ;     Sets the default detail that is used when displaying mail objects
  124. ;     in your outbound holding area by the Outbound Manager.
  125. ;
  126. ;     FILEs ... Include files other than packets, attaches, and requests.
  127. ;
  128. ;     When FILEs are included, include the following types ...
  129. ;
  130. ;        NOCALLs ... Bad Connect Marker Files
  131. ;        ZARCs ..... Zero-length mail archives (MO#, TU#, etc)
  132. ;        ZMODs ..... Incomplete ZMODEM transfer restart data files
  133. ;        ALL ....... All above file types
  134. ;
  135. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  136. ;  EXEC   { OUTBOUND | NODELIST | LOGVIEW | USER | AREA | EVENTS }
  137. ;
  138. ;     If given, Oman jump starts into the given function without going
  139. ;     through the initial PARAMETER or MAIN MENU and directly exits to
  140. ;     DOS upon completion of that function.  Good for quick entry and exit
  141. ;     as might be the case in some REMOTE access situations.
  142. ;
  143. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  144. ;  NAKEDREQ
  145. ;
  146. ;     Use to disable the creation of a matching POLL for any File
  147. ;     Requests created in the Outbound manager.  When not used,
  148. ;     a separate POLL item is made to force a call to the destination.
  149. ;
  150. ;
  151. ;-----------------------------------------------------------------------
  152. ;  OPUS RELATED ITEMS  (normally set from given OPUS.PRM file)
  153. ;-----------------------------------------------------------------------
  154. ;
  155. ;  OUTbound   { path }
  156. ;
  157. ;     Sets the path to your outbound mail holding area as used by the
  158. ;     Outbound Manager in those cases where the one in the PRM file
  159. ;     is not the one you want or when you are not using a PRM file.
  160. ;
  161. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  162. ;  HELP   { path }
  163. ;
  164. ;     Sets the path to where your OMAN.HLP file is located if it is
  165. ;     it not located in your OMAN home directory as is normal.
  166. ;
  167. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  168. ;  NETINFO   { path }
  169. ;
  170. ;     Sets the path to your nodelist directory as used by the NodeList
  171. ;     Manager in those cases where the one in the PRM file is not the one
  172. ;     you want or when you are not using a PRM file.
  173. ;
  174. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  175. ;  NETID   { z:district/node }
  176. ;
  177. ;     Sets the FidoNet address that Oman uses in the Outbound Manager
  178. ;     when the primary one in your PRM file is not the one you want or
  179. ;     when you are not using a PRM file.
  180. ;
  181. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  182. ;  LOGFile   { path\name.ext }
  183. ;
  184. ;     Sets the path to your Opus Log file as used by the Log Viewer in
  185. ;     those cases where the one in the PRM file is not the one you want
  186. ;     or when you are not using a PRM file.
  187. ;
  188. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  189. ;  USERfile   { path\name }
  190. ;
  191. ;     Sets the path to your Opus User File file as used by the User Manager
  192. ;     in those cases where the one in the PRM file is not the one you want
  193. ;     or when you are not using a PRM file.
  194. ;
  195. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  196. ;  SCHEDule   { path\name }
  197. ;
  198. ;     Sets the path to your Opus Schedule file as used by the Event Manager
  199. ;     in those cases where the one in the PRM file is not the one you want
  200. ;     or when you are not using a PRM file.
  201. ;
  202. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  203. ;  OPUSSys   { path }
  204. ;
  205. ;     Sets the path to your Opus System directory as used by most functions
  206. ;     in those cases where the one in the PRM file is not the one you want
  207. ;     or when you are not using a PRM file.
  208. ;
  209. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  210. ;  GLOBAL   { path\name.ext }
  211. ;
  212. ;     Sets the path to a special, common, data file that holds the total
  213. ;     call count to your system as well as the quote pointer when any
  214. ;     that is given in the PRM file is not the one you want or a PRM
  215. ;     file is not used.
  216. ;
  217. ;     Normally, Opus uses the given Event file to hold these values but
  218. ;     in multiline cases, a common file is needed in order to accumulate
  219. ;     the true total call count across all lines.  This data is accessed
  220. ;     by the Global Manager function.
  221. ;
  222. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  223. ;  NETMSG   { path }
  224. ;
  225. ;     Sets the path to your FidoNet mail message area if different than
  226. ;     in your PRM file or if no PRM file is used.  Not currently used.
  227. ;
  228. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  229. ;  INFile   { path }
  230. ;
  231. ;     Sets the path to your FidoNet mail inbound files area if different
  232. ;     than in your PRM file or if no PRM file is used.  Not currently used.
  233. ;
  234. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  235. ;  SYSOP   { name }
  236. ;
  237. ;     Sysop name to use if other than as per PRM file or if no PRM file
  238. ;     is used.  For screen displays only.
  239. ;
  240. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  241. ;  SYSTEM   { name }
  242. ;
  243. ;     System name to use if other than as per PRM file or if no PRM file
  244. ;     is used.  For screen displays only.
  245. ;
  246.  
  247.  
  248. ;-----------------------------------------------------------------------
  249. ;  OUTPUT TRANSLATION ITEMS
  250. ;-----------------------------------------------------------------------
  251. ;
  252. ;  SYMBOLS   { IBM | ASCII }
  253. ;
  254. ;     If ASCII, Oman converts any Extended-IBM-ASCII graphic text into
  255. ;     its nearest ASCII equivalent, if possible.  Use only when your
  256. ;     computer setup cannot display IBM Graphics.  Default is IBM which
  257. ;     displays such characters unaltered.
  258. ;
  259. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  260. ;  XLTOUT   {path\file.ext}  [ DUMP ]
  261. ;
  262. ;     Defines and alternate 256 byte translate table to be used when
  263. ;     displaying all output (not for input).  This is to accommodate those
  264. ;     systems that have character sets that are similar, but not identical,
  265. ;     to the IBM extended character set as is the case with DEC Rainbows.
  266. ;
  267. ;     If the 2nd paramter "DUMP" is used, the path is taken to be an
  268. ;     output table to which the internal Oman translate table is dumped to.
  269. ;     This is handy if you want create such a table but want to use the
  270. ;     the internal one as a starting point to modify with a binary editor.
  271. ;     Only use this mode once, create the file, then remove it.
  272. ;
  273. ;
  274. ;
  275. ;-----------------------------------------------------------------------
  276. ;  REMOTE OPERATION ITEMS
  277. ;-----------------------------------------------------------------------
  278. ;
  279. ;  PORT   { 1 | 2 }
  280. ;
  281. ;     Sets the COMM PORT to use when operating remotely.
  282. ;     Normally, the -Pn command line parameter sets this.  Use where
  283. ;     the PORT is never changed and the -Pn parameter is not passed
  284. ;     to Oman in remote invocation situations.
  285. ;
  286. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  287. ;  SPEED   { 300, 1200, 2400, 4800, 9600, 19200, 38400 }
  288. ;
  289. ;     Sets the BAUD RATE to use when operating remotely.
  290. ;     Normally, the -Bn command line parameter sets this.  Use where
  291. ;     the SPEED is never changed and the -Bn parameter is not passed
  292. ;     to Oman in remote invocation situations.
  293. ;
  294. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  295. ;  REMPWD   { password }
  296. ;
  297. ;     Sets a password that is asked for and checked when you are invoking
  298. ;     Oman remotely.  It is intended to be a minimal but added level of
  299. ;     security when remotely accessing Oman due to the extreme power that
  300. ;     Oman would give to an interloper.
  301. ;
  302. ;- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  303. ;  FOSSIL   { ACTIVE }
  304. ;
  305. ;     When operating remotely, leaves FOSSIL active upon exit, bypassing
  306. ;     any final de-initialization.  Use for remotely invocated from a
  307. ;     parent remote process such as when running from an Opus menu.
  308. ;
  309. ;
  310. ;-----------------------------------------------------------------------
  311. ;  End of Ref - Tom Kashuba and Ulf Nilsson
  312. ;-----------------------------------------------------------------------
  313.